[correlationId] Make correlationId a required parameter on AuthError constructors (breaking) by sameerag · Pull Request #8609 · AzureAD/microsoft-authentication-library-for-js

sameerag · 2026-05-27T06:55:57Z

Summary

** Makes correlationId a required parameter on the AuthError constructor (and all subclass error constructors) across every MSAL package. This ensures thrown errors carry correlation context consistently for telemetry and debugging.

Previously correlationId was attached after construction via setCorrelationId(), which was inconsistently called. That helper is removed; the value is now required at construction.

Scope of this PR

This PR now serves as the single consolidated PR for the correlationId error propagation work (instead of the original stacked split).

Changes

`@azure/msal-common`

AuthError constructor signature changed from (errorCode, errorMessage?, suberror?) to (errorCode, correlationId, errorMessage?, suberror?).
All subclasses updated: ClientAuthError, ClientConfigurationError, InteractionRequiredAuthError, ServerError, JoseHeaderError, NetworkError, CacheError.
setCorrelationId() removed.
Error helper signatures and call sites updated to pass correlationId (or "" where not yet in scope).
API review file regenerated to reflect new public signatures.

`@azure/msal-browser`

Updated error construction paths to pass required correlationId.
Native auth error translation updated and test coverage expanded for correlationId propagation.

`@azure/msal-node`, `@azure/msal-node-extensions`, `@azure/msal-react`, `@azure/msal-angular`

Mechanical fan-out: error throw paths updated to pass correlationId (or "" where not in scope).

Change files

Major version bump change files included for affected packages.

Migration

// Before
throw new AuthError("my_code", "my message");
err.setCorrelationId(corrId);

// After
throw new AuthError("my_code", corrId, "my message");

Adds an optional correlationId parameter to createAuthError, createClientAuthError, createClientConfigurationError, createInteractionRequiredAuthError, createBrowserAuthError, createBrowserConfigurationAuthError, and createNativeAuthError. Updates msal-browser and msal-common call sites to forward the current request correlationId so thrown errors carry it for telemetry/debugging.

Copilot

Pull request overview

This PR improves MSAL telemetry/debuggability by propagating the current request correlationId into errors created via msal-common/msal-browser error factory helpers, and updates internal throw sites and unit tests accordingly.

Changes:

Add optional correlationId parameters to several error creation helpers and forward correlationId at key throw sites.
Update native broker error translation (createNativeAuthError) to apply correlationId across translated error types.
Add/extend unit tests to verify correlationId behavior for updated helpers.

Reviewed changes

Copilot reviewed 26 out of 26 changed files in this pull request and generated 6 comments.

Show a summary per file

File	Description
lib/msal-common/test/error/InteractionRequiredAuthError.spec.ts	Adds tests asserting `correlationId` behavior for interaction-required error factory.
lib/msal-common/test/error/ClientConfigurationError.spec.ts	Adds tests asserting `correlationId` behavior for client configuration error factory.
lib/msal-common/test/error/ClientAuthError.spec.ts	Adds tests asserting `correlationId` behavior for client auth error factory.
lib/msal-common/test/error/AuthError.spec.ts	Adds tests asserting `correlationId` behavior for base auth error factory.
lib/msal-common/src/error/InteractionRequiredAuthError.ts	Extends interaction-required error factory signature to accept `correlationId`.
lib/msal-common/src/error/ClientConfigurationError.ts	Extends configuration error factory signature to accept/set `correlationId`.
lib/msal-common/src/error/ClientAuthError.ts	Extends client auth error factory signature to accept/set `correlationId`.
lib/msal-common/src/error/AuthError.ts	Extends base auth error factory signature to accept/set `correlationId`.
lib/msal-common/src/client/SilentFlowClient.ts	Forwards `request.correlationId` when throwing client auth errors.
lib/msal-common/src/client/RefreshTokenClient.ts	Forwards `request.correlationId` when throwing interaction-required errors.
lib/msal-common/src/client/AuthorizationCodeClient.ts	Forwards `request.correlationId` when throwing client/configuration errors.
lib/msal-browser/test/error/NativeAuthError.spec.ts	Adds tests asserting `correlationId` is preserved on translated native errors.
lib/msal-browser/test/error/BrowserConfigurationAuthError.spec.ts	Adds tests asserting `correlationId` behavior for browser configuration error factory.
lib/msal-browser/test/error/BrowserAuthError.spec.ts	Adds tests asserting `correlationId` behavior for browser auth error factory.
lib/msal-browser/src/interaction_client/SilentAuthCodeClient.ts	Forwards `correlationId` into thrown browser auth errors.
lib/msal-browser/src/interaction_client/PopupClient.ts	Forwards `correlationId` into thrown browser auth errors in popup flows.
lib/msal-browser/src/interaction_client/PlatformAuthInteractionClient.ts	Forwards `correlationId` into thrown common/browser errors in platform auth flows.
lib/msal-browser/src/interaction_client/BaseInteractionClient.ts	Forwards `correlationId` into thrown common configuration errors.
lib/msal-browser/src/error/NativeAuthError.ts	Extends native error translation to accept/apply `correlationId`.
lib/msal-browser/src/error/BrowserConfigurationAuthError.ts	Extends browser configuration error factory to accept/set `correlationId`.
lib/msal-browser/src/error/BrowserAuthError.ts	Extends browser auth error factory to accept/set `correlationId`.
lib/msal-browser/src/controllers/StandardController.ts	Forwards `correlationId` into thrown common/browser errors in controller paths.
lib/msal-browser/src/broker/nativeBroker/PlatformAuthExtensionHandler.ts	Forwards `correlationId` when translating/throwing native and auth errors.
lib/msal-browser/src/broker/nativeBroker/PlatformAuthDOMHandler.ts	Forwards `correlationId` when translating/throwing native and auth errors.
change/@azure-msal-common-151e2ba1-220e-4a47-a4dc-e421d262da2a.json	Adds patch changefile for msal-common.
change/@azure-msal-browser-7c559b7a-066d-486b-b68f-4b4359e3f053.json	Adds patch changefile for msal-browser.

 export function createAuthError(
    code: string,
-    additionalMessage?: string
+    additionalMessage?: string,
+    correlationId?: string
 ): AuthError {


Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>

…tors Breaking change: correlationId is now a mandatory positional parameter (position 2, before optional errorMessage/additionalMessage) on: - AuthError, ClientAuthError, ClientConfigurationError - InteractionRequiredAuthError, ServerError - JoseHeaderError, PlatformBrokerError The setCorrelationId() method has been removed from AuthError. Callers should assign to the public correlationId field directly if they need to set it after construction. All factory functions (createAuthError, createClientAuthError, createClientConfigurationError, createInteractionRequiredAuthError, createJoseHeaderError) now require correlationId as the second argument.

… stray file

Copilot · 2026-05-30T01:05:05Z

@copilot Is the format fixed?

Yes—it's fixed. The stack format is [correlationId X/4] ..., and the four PRs are #8609, #8616, #8617, and #8618.

sameerag · 2026-06-01T17:07:42Z

@copilot What are these outstanding changes?

Copilot · 2026-06-01T17:09:14Z

@copilot What are these outstanding changes?

Only one code-review item is still outstanding on this PR: updating lib/msal-common/apiReview/msal-common.api.md to reflect the new correlationId-aware factory signatures. The other review comments in this PR thread are resolved. The remaining broader correlationId follow-up work is in the stacked PRs #8616, #8617, and #8618.

sameerag · 2026-06-01T17:09:37Z

@copilot On the local branch I mean

Copilot · 2026-06-01T17:11:34Z

@copilot On the local branch I mean

Locally there are no outstanding uncommitted changes right now — working tree is clean on copilot/fix-8609 (git status shows nothing to commit). The latest local commits are already the PR updates (including fb5d618 for msal-common.api.md and 2679024 for NativeAuthError test coverage).

sameerag · 2026-06-01T22:22:00Z

@copilot Can we please collapse all PRs into one, as the changes are still many and would like a central place to handle all of them?

Copilot · 2026-06-01T22:23:38Z

@copilot Can we please collapse all PRs into one, as the changes are still many and would like a central place to handle all of them?

Yes — we can consolidate. I can stop the stacked approach and put the remaining correlationId changes into this single PR so there’s one central place to review. I can’t merge/close PRs directly from here, so once we move the remaining changes here, please close the other stacked PRs.

sameerag · 2026-06-01T22:24:14Z

@copilot Have you checked it in and made the changes in the PR notes + change files?

Copilot · 2026-06-01T22:25:50Z

@copilot Have you checked it in and made the changes in the PR notes + change files?

Code/check-ins are done, and the change files are updated (including the #8609 link format). PR notes are not yet updated to remove the old stacked/TBD wording — that still needs to be adjusted in the PR description text.

sameerag · 2026-06-01T22:36:40Z

@copilot Can we update the PR description please?

Copilot · 2026-06-01T22:39:18Z

@copilot Can we update the PR description please?

Yes — I can prepare the updated text right away. I don’t have a direct tool here to edit the PR body itself, so please paste this updated description into the PR notes and I’ll keep subsequent updates aligned to it:

Summary

Breaking change. Makes correlationId a required parameter on the AuthError constructor (and all subclass error constructors) across every MSAL package. This ensures thrown errors carry correlation context consistently for telemetry and debugging.

Previously correlationId was attached after construction via setCorrelationId(), which was inconsistently called. That helper is removed; the value is now required at construction.

Scope of this PR

This PR now serves as the single consolidated PR for the correlationId error propagation work (instead of the original stacked split).

Changes

`@azure/msal-common`

AuthError constructor signature changed from (errorCode, errorMessage?, suberror?) to (errorCode, correlationId, errorMessage?, suberror?).
All subclasses updated: ClientAuthError, ClientConfigurationError, InteractionRequiredAuthError, ServerError, JoseHeaderError, NetworkError, CacheError.
setCorrelationId() removed.
Error helper signatures and call sites updated to pass correlationId (or "" where not yet in scope).
API review file regenerated to reflect new public signatures.

`@azure/msal-browser`

Updated error construction paths to pass required correlationId.
Native auth error translation updated and test coverage expanded for correlationId propagation.

`@azure/msal-node`, `@azure/msal-node-extensions`, `@azure/msal-react`, `@azure/msal-angular`

Mechanical fan-out: error throw paths updated to pass correlationId (or "" where not in scope).

Change files

Major version bump change files included for affected packages.

Migration

// Before
throw new AuthError("my_code", "my message");
err.setCorrelationId(corrId);

// After
throw new AuthError("my_code", corrId, "my message");

sameerag · 2026-06-01T22:42:32Z

@copilot Can we close the remaining PRs?

Copilot · 2026-06-01T22:44:02Z

@copilot Can we close the remaining PRs?

I can’t close PRs directly from this environment. Please close #8616, #8617, and #8618 from GitHub UI, and I’ll keep all remaining correlationId updates consolidated in this PR.

Copilot AI review requested due to automatic review settings May 27, 2026 06:55

sameerag requested a review from a team as a code owner May 27, 2026 06:55

Copilot started reviewing on behalf of sameerag May 27, 2026 06:56 View session

Copilot AI reviewed May 27, 2026

View reviewed changes

sameerag and others added 6 commits May 27, 2026 00:05

Expand correlationId propagation to remaining error throw sites

8035e85

Add PR link to changefile comments

84688d4

Potential fix for pull request finding

2c218e8

Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>

Potential fix for pull request finding

890284a

Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>

Merge branch 'dev' into correlationId-in-errorpath

7229b37

Update msal-common api review for correlationId param

6335b96

Copilot started work on behalf of sameerag May 27, 2026 19:57 View session

Copilot started work on behalf of sameerag May 27, 2026 19:58 View session

Copilot finished work on behalf of sameerag May 27, 2026 20:00

Copilot finished work on behalf of sameerag May 27, 2026 20:04

tnorling reviewed May 27, 2026

View reviewed changes

Comment thread lib/msal-common/src/error/AuthError.ts Outdated

sameerag added 7 commits May 27, 2026 14:01

Refactor msal-browser to use mandatory correlationId in errors

726b54c

msal-node: mandatory correlationId in error constructors

840a5c2

msal-node-extensions: mandatory correlationId in error constructors

777bfc0

msal-react: mandatory correlationId in error constructors

575bc89

msal-angular: mandatory correlationId in error constructors

75b06b0

Add changefiles for correlationId breaking change; bump types; remove…

2203613

… stray file

sameerag requested review from a team, mustafamizrak, nilo-ms, shenj, spetrescu84 and yongdiw as code owners May 27, 2026 22:15

Apply prettier formatting to correlationId refactor changes

098cb6e

Copilot finished work on behalf of sameerag May 30, 2026 01:05

Copilot started work on behalf of sameerag June 1, 2026 17:07 View session

Copilot finished work on behalf of sameerag June 1, 2026 17:09

Copilot started work on behalf of sameerag June 1, 2026 17:09 View session

Copilot finished work on behalf of sameerag June 1, 2026 17:11

Copilot started work on behalf of sameerag June 1, 2026 22:22 View session

Copilot finished work on behalf of sameerag June 1, 2026 22:23

Copilot started work on behalf of sameerag June 1, 2026 22:24 View session

Copilot finished work on behalf of sameerag June 1, 2026 22:26

Copilot started work on behalf of sameerag June 1, 2026 22:36 View session

Copilot AI changed the title ~~[correlationId 1/4] Make correlationId a required parameter on AuthError constructors (breaking)~~ [correlationId] Make correlationId a required parameter on AuthError constructors (breaking) Jun 1, 2026

Copilot finished work on behalf of sameerag June 1, 2026 22:39

Copilot started work on behalf of sameerag June 1, 2026 22:42 View session

Copilot finished work on behalf of sameerag June 1, 2026 22:44

Merge branch 'dev' into correlationId-in-errorpath

441dc21

Copilot started work on behalf of sameerag June 2, 2026 22:58 View session

Copilot stopped work on behalf of sameerag due to an error June 2, 2026 22:59
The session was cancelled by the user.

Conversation

sameerag commented May 27, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary

Scope of this PR

Changes

@azure/msal-common

@azure/msal-browser

@azure/msal-node, @azure/msal-node-extensions, @azure/msal-react, @azure/msal-angular

Change files

Migration

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Copilot AI commented May 30, 2026

Uh oh!

sameerag commented Jun 1, 2026

Uh oh!

Copilot AI commented Jun 1, 2026

Uh oh!

sameerag commented Jun 1, 2026

Uh oh!

Copilot AI commented Jun 1, 2026

Uh oh!

sameerag commented Jun 1, 2026

Uh oh!

Copilot AI commented Jun 1, 2026

Uh oh!

sameerag commented Jun 1, 2026

Uh oh!

Copilot AI commented Jun 1, 2026

Uh oh!

sameerag commented Jun 1, 2026

Uh oh!

Copilot AI commented Jun 1, 2026

Summary

Scope of this PR

Changes

@azure/msal-common

@azure/msal-browser

@azure/msal-node, @azure/msal-node-extensions, @azure/msal-react, @azure/msal-angular

Change files

Migration

Uh oh!

sameerag commented Jun 1, 2026

Uh oh!

Copilot AI commented Jun 1, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

sameerag commented May 27, 2026 •

edited

Loading

`@azure/msal-common`

`@azure/msal-browser`

`@azure/msal-node`, `@azure/msal-node-extensions`, `@azure/msal-react`, `@azure/msal-angular`

`@azure/msal-common`

`@azure/msal-browser`

`@azure/msal-node`, `@azure/msal-node-extensions`, `@azure/msal-react`, `@azure/msal-angular`